home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / xcbv11.zip / XCBV.DOC < prev    next >
Text File  |  1992-09-04  |  12KB  |  271 lines
  1.  
  2.                     ╔══════════════════════════════════╗
  3.                     ║  The Express Call-Back Verifier  ║
  4.                     ║           Version 1.1            ║
  5.                     ║   For Renegade Bulletin Boards   ║
  6.                     ║   Copyright 1992 Phil Baggett    ║
  7.                     ║       All Rights Reserved        ║
  8.                     ╚══════════════════════════════════╝
  9.  
  10.  
  11. FILE LIST
  12. ---------
  13.  
  14. The Express Call-Back Verifier (XCBV) package consists of the following
  15. files:
  16.  
  17.     XCBV.EXE - Main program
  18.     XCBV.BAT - Sample batch file
  19.     XCBV.DOC - Program documentation
  20.     XCBV.DAT - Call-back database
  21.     XCBV.CFG - Configuration file
  22.  
  23.     INTRO.TXT    - [ Sample  ]
  24.     INSTRUCT.TXT - [ display ]
  25.     SUCCESS.TXT  - [ files   ]
  26.     BADACODE.TXT - [         ]
  27.  
  28.  
  29. COMPATIBILITY
  30. -------------
  31.  
  32. This version of the XCBV was written for Renegade release 8-10 (beta) or
  33. later.  I plan to modify this program as needed to be compatible with future
  34. versions of Renegade unless there's no demand for it, so if you like it,
  35. TELL ME!
  36.  
  37.  
  38. LICENSE
  39. -------
  40.  
  41. No person shall use this software on a regular basis without first notifying
  42. the Author, Phil Baggett, via conventional mail or some form of electronic
  43. mail, and thereby receiving permission.  There is NO FEE involved.  The
  44. Author only wishes to be informed as to where his creation is being
  45. implemented.
  46.  
  47.  
  48. INTRODUCTION
  49. ------------
  50.  
  51. The Express Call-Back Verifier serves two main purposes:
  52.  
  53.     (1) Automatically upgrades users' SL and DSL to predetermined values
  54.         after successful verification.
  55.  
  56.     (2) Keeps a record of users' tested-and-verified phone numbers.
  57.  
  58.     (3) Allows SysOps to prevent users from calling under multiple user
  59.         accounts.
  60.  
  61. This CBV is quite different from others you may have used.  First of all,
  62. this program, when calling the user back for verification, does not dial the
  63. area code.  Therefore, it WILL NOT DIAL LONG DISTANCE unless you can do so
  64. in your area by omitting the area code and dialing only the 3-digit prefix
  65. and the 4-digit suffix of the number.
  66.  
  67. In fact, users' area codes are not stored in the phone number database at
  68. all.  This feature should be welcomed by those who hate calling long
  69. distance, as I do, and hated by those who like their BBSs to call back any
  70. user, regardless of the phone bill incurred.
  71.  
  72.     ■  SysOps can search through and edit the call-back database, which will
  73.        contain each verified user's real name, phone number, and date of
  74.        verification.
  75.  
  76.     ■  A special option is included for globally scanning and updating the
  77.        call-back database, so SysOps can plug some or all users' current
  78.        phone numbers into the database.
  79.  
  80.     ■  Customized text or ANSI files will be displayed at appropriate times
  81.        when the door is being run, so you can give the program a personal
  82.        touch.
  83.  
  84.     ■  Keeps a detailed log of all errors and call-back failures.
  85.  
  86.  
  87. INSTALLATION
  88. ------------
  89.  
  90. To install the program, make a new subdirectory and copy all the files
  91. there.  Use a text editor to modify the configuration file, XCBV.CFG:
  92.  
  93.     Line 1:  Name of your BBS.
  94.  
  95.     Line 2:  Name of your BBS drop file (NOT including path); must be either
  96.              CALLINFO.BBS, PCBOARD.SYS, or DORINFOx.DEF.  (DOOR.SYS, as
  97.              generated by Renegade, will not work with this program, due to
  98.              the fact that my door-building toolkit does not support the new
  99.              (longer) DOOR.SYS standard that Renegade produces <sigh>.)
  100.              CALLINFO.BBS has been tested with Renegade and is recommended.
  101.  
  102.     Line 3:  Should be a line of the following form (which tells the program
  103.              to use a fossil driver):
  104.  
  105.                  PORT:F:C
  106.  
  107.              where C is the COM port number (for example, PORT:F:1 for
  108.              fossil on COM1).  This configuration line was included to allow
  109.              future expansion for supporting non-standard port base
  110.              addresses and IRQs should Renegade drop fossil driver reliance.
  111.  
  112.     Line 4:  BBS main directory (for example, C:\BBS\).
  113.  
  114.     Line 5:  BBS data directory (for example, C:\BBS\DATA\).
  115.  
  116.     Line 6:  SysOp security level.  When a user with this SL runs the door,
  117.              the program will allow the user to run in Edit Mode.
  118.  
  119.     Line 7:  New SL to be given after successful verification.
  120.  
  121.     Line 8:  New DSL to be given after successful verification.
  122.  
  123.     Line 9:  Area code that your BBS is in.  The program will refuse to call
  124.              back any user who doesn't have this area code.
  125.  
  126. Now edit the special display files as desired.  (Make sure you replace any
  127. area codes mentioned in the files with YOUR area code.)  When the program
  128. needs to display one of these, it first looks for the filename with the .ANS
  129. extension, and if found, shows it as an ANSI display.  Otherwise, it looks
  130. for the .TXT extension and shows it.  (This method is similar to how
  131. Renegade itself works.)  The files (not including extensions) are:
  132.  
  133.     INTRO    - Displayed first, just after the program title screen.
  134.     INSTRUCT - Displayed just before asking the user if he/she is ready to
  135.                disconnect for call-back.
  136.     SUCCESS  - Displayed after successful verification.
  137.     BADACODE - Displayed when user isn't in the correct area code and
  138.                therefore can't complete the call-back procedure.
  139.  
  140. Next, make a batch file (or modify the sample provided) that changes to the
  141. correct directory and executes the main program.  Example:
  142.  
  143.     cd \bbs\doors\xcbv
  144.     xcbv
  145.  
  146. Finally, inside Renegade, add a menu command to run this batch file.  You
  147. might want to have Renegade automatically run the CBV if a user has a
  148. certain "new user" SL, or you can put the option on a displayed menu, or
  149. both.  Refer elsewhere for help with Renegade's menu commands.
  150.  
  151.  
  152. USING THE PROGRAM
  153. -----------------
  154.  
  155. Before you use this program, BACKUP YOUR USER FILES!  The files that this
  156. program uses are RENEGADE.DAT (main BBS directory), USERS.DAT and USERS.IDX
  157. (both in data directory).  Although it's been tested extensively, there are
  158. no guarantees.  Be warned.
  159.  
  160. This program will function locally (without a real carrier), but it will not
  161. attempt the actual call-back process.  It will simply upgrade the user who
  162. runs it locally (which is really not very useful).
  163.  
  164. If you or a user gets the "Fatal Error" message, check the log file,
  165. XCBV.LOG.  You also need to periodically check the log to make sure folks
  166. are not having problems.  The most recent messages are listed at the bottom
  167. of the file.  You can edit or delete the log file at any time if desired.
  168.  
  169. Use of the program is fairly straightforward.  When the program is run, it
  170. allows the user to correct the phone number if necessary (allowing only YOUR
  171. area code), then disconnects, calls the user back, and asks for the user's
  172. BBS password.  On success, the user's REAL name and phone number are stored
  173. in the database, and the user is upgraded to the SL and DSL given in the
  174. configuration file (see INSTALLATION), and returned to the BBS.
  175.  
  176. If verification fails, either because it can't reconnect, the user failed
  177. the password check, or the user's phone number is already recorded, the
  178. user's security level is unchanged, and the reason for failure is written to
  179. the log file.  In this case, upon returning to the board Renegade will
  180. detect a lost carrier, so there will be a "Hung up" entry in Renegade's
  181. sysop log, which is normal.
  182.  
  183. Since the program won't upgrade callers outside your area code or users who
  184. duplicate a phone number already on record, in these cases manual
  185. verification is necessary for those to whom you want to grant access.
  186.  
  187.  
  188. EDIT MODE
  189. ---------
  190.  
  191. A user with the configured SysOp SL (see INSTALLATION) can run the CBV in
  192. "Edit Mode".  This mode allows viewing/editing of the call-back database.
  193. You can search for a certain record by partial user real name or phone
  194. number, and make any desired changes.  Most commands on the menus are
  195. self-explanatory.  Note that you can usually abort an operation by just
  196. hitting ENTER at the prompt.
  197.  
  198. IMPORTANT:  Never try to empty the database by deleting the file (XCBV.DAT).
  199.             Instead, use the "Zap database" option.
  200.  
  201. When running searches on the database, just hitting ENTER when prompted for
  202. a "partial" name or number causes every record to match, thus allowing you
  203. to view all records in sequence.  Otherwise, if you enter a search string
  204. the program will find records that contain that string of characters
  205. anywhere in the field.
  206.  
  207.  
  208. ADDING NUMBERS FROM YOUR BBS USER FILE
  209. --------------------------------------
  210.  
  211. One Edit Mode option that deserves explanation, the "Scan & update records"
  212. option, was included so that you could have a fairly accurate and complete
  213. record of all your current users' phone numbers when you first install the
  214. XCBV, without forcing all current users to run the verifier.  USE THIS WITH
  215. CAUTION, because indiscriminate use will cause undesired results to the
  216. database.  If the program has already verified a substantial number of
  217. people, you might want to backup the database before using this option.
  218.  
  219. With this option, you can scan for certain user names, certain security
  220. levels, or all users.  It searches through your BBS user file, looking for
  221. numbers (in your area code) that are not already in the call-back database,
  222. and adds them.  Keep in mind that the numbers in Renegade's user file are
  223. users' voice numbers, so in a few cases the number added to the call-back
  224. database may not be the user's data line.
  225.  
  226. The "scan" option also reports (on screen and to the log file) any duplicate
  227. phone numbers it finds (when the users' real names don't match), which is
  228. helpful for tracking down users who have already logged on as different
  229. people (if the user gave the same phone number every time).  Remember that
  230. these may in fact be seperate individuals who reside in the same household,
  231. so you'll have to decide what to do about their access (voice verification
  232. perhaps).  In the case of duplicates, the one already in the database will
  233. remain there, and the duplicate in the user file is not added.
  234.  
  235. Remember, the "Scan & update records" option should normally only be needed
  236. ONCE--when you first install the verifier--if you use it at all.  After
  237. that, the program will keep a lookout for duplicate numbers as each user
  238. tries to get verified.
  239.  
  240.  
  241. CONTACTING THE AUTHOR
  242. ---------------------
  243.  
  244. Thanks for trying this program, and if you have any comments, questions, or
  245. problems, please let me know.  The quickest way to reach me is to call my
  246. BBS:
  247.  
  248.         Unitron
  249.     (404) 445-8200
  250.  
  251. I can also be reached through one of the Renegade echos.  Just send mail to
  252. Phil Baggett.  If you prefer, or if you can't seem to reach me any other
  253. way, please write to this address:
  254.  
  255.     Phil Baggett
  256.     3285 Buchanan Hwy.
  257.     Dallas, GA  30132
  258.  
  259.  
  260. DISCLAIMER
  261. ----------
  262.  
  263. The Author, Phil Baggett, hereby disclaims all warranties, express or
  264. implied, concerning this software.  The Author shall not be liable for any
  265. damage caused by this software, whether or not he is aware that such damage
  266. may occur.  By using this software, the user agrees to these terms.
  267.  
  268. Furthermore, I don't guarantee that this program won't scramble or otherwise
  269. destroy or deface your user files, or any other file, in some vicious and
  270. unpredictable way.
  271.